docs: Add Linux Python build requirements for bzip2 and lzma #11983
+16
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes Comfy-Org#3219 Documents that Linux users building Python from source need to install libbz2-dev and liblzma-dev (Debian/Ubuntu) or bzip2-devel and xz-devel (RHEL/Fedora/CentOS) before building Python to ensure the _bz2 and _lzma standard library modules are available. This helps users who install Python via pyenv, asdf, or compile from source avoid cryptic import errors when running ComfyUI.
sasankkurnella
requested review from
Kosinkadink,
comfyanonymous and
guill
as code owners
Member
Test Evidence CheckIf this PR modifies behavior that requires testing, a test explanation is required. PRs lacking applicable test explanations may not be reviewed until added. Please add test explanations to ensure code quality and prevent regressions. If this PR changes user-facing behavior, visual proof (screen recording or screenshot) is required. PRs without applicable visual documentation may not be reviewed until provided. You can add it by:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3219
Documents that Linux users building Python from source need to install
libbz2-devandliblzma-dev(Debian/Ubuntu) orbzip2-develandxz-devel(RHEL/Fedora/CentOS) before building Python to ensure the_bz2and_lzmastandard library modules are available.This helps users who install Python via pyenv, asdf, or compile from source avoid cryptic import errors when running ComfyUI.
Test Evidence
N/A - This is a documentation-only change. No code behavior is modified, so no testing is required.
Visual Documentation
N/A - This PR does not change any user-facing behavior or UI. It only adds installation instructions to the README.md for Linux users building Python from source.
Summary of Changes
README.mdWhy This Change?
Linux users who compile Python (via
pyenv,asdf, or manual build) may encounter:This happens because Python's build process silently skips these modules if the development libraries aren't installed beforehand. This documentation helps users avoid hours of debugging.